| Package | hl7.fhir.uv.omop |
| Resource Type | StructureDefinition |
| Id | NoteNLP |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-NoteNLP.html |
| URL | http://hl7.org/fhir/uv/omop/StructureDefinition/NoteNLP |
| Version | 1.0.0-ballot |
| Status | active |
| Date | 2025-07-29T17:40:15+00:00 |
| Name | NoteNLP |
| Title | Note NLP OMOP Table |
| Realm | uv |
| Authority | hl7 |
| Description | The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note. |
| Type | http://hl7.org/fhir/uv/omop/StructureDefinition/NoteNLP |
| Kind | logical |
No resources found
| StructureDefinition | |
| Note | Note OMOP Table |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition NoteNLP
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  NoteNLP | 0..* | Base | Note NLP OMOP Table Instances of this logical model can be the target of a Reference | |
  note_nlp_id | 1..1 | code | Note NLP Identifier | |
 note_id | 1..1 | Reference(Note OMOP Table) | Note | |
| section_concept_id | 0..1 | code | Section | |
| snippet | 0..1 | string | Snippet | |
| offset | 0..1 | string | Offset | |
| lexical_variant | 1..1 | string | Lexical Variant | |
| note_nlp_concept_id | 0..1 | code | Note NLP | |
| note_nlp_source_concept_id | 0..1 | code | Note NLP Source | |
| nlp_system | 0..1 | string | NLP System | |
| nlp_date | 1..1 | date | NLP Date | |
| nlp_datetime | 0..1 | dateTime | NLP Datetime | |
| term_exists | 0..1 | string | Term Exists | |
| term_temporal | 0..1 | string | Term Temporal | |
 term_modifiers | 0..1 | string | Term Modifiers | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "NoteNLP",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "brr"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/omop/StructureDefinition/NoteNLP",
"version": "1.0.0-ballot",
"name": "NoteNLP",
"title": "Note NLP OMOP Table",
"status": "active",
"date": "2025-07-29T17:40:15+00:00",
"publisher": "HL7 International / Biomedical Research and Regulation",
"contact": [
{
"name": "HL7 International / Biomedical Research and Regulation",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/rcrim"
}
]
}
],
"description": "The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/omop/StructureDefinition/NoteNLP",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "NoteNLP",
"path": "NoteNLP",
"short": "Note NLP OMOP Table",
"definition": "The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "NoteNLP.note-nlp-id",
"path": "NoteNLP.note_nlp_id",
"short": "Note NLP Identifier",
"definition": "Note NLP Identifier",
"min": 1,
"max": "1",
"base": {
"path": "NoteNLP.note_nlp_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "NoteNLP.note-id",
"path": "NoteNLP.note_id",
"short": "Note",
"definition": "This is the NOTE_ID for the NOTE record the NLP record is associated to.",
"min": 1,
"max": "1",
"base": {
"path": "NoteNLP.note_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/uv/omop/StructureDefinition/Note"
]
}
]
},
{
"id": "NoteNLP.section-concept-id",
"path": "NoteNLP.section_concept_id",
"short": "Section",
"definition": "Section",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.section_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "NoteNLP.snippet",
"path": "NoteNLP.snippet",
"short": "Snippet",
"definition": "A small window of text surrounding the term",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.snippet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.offset",
"path": "NoteNLP.offset",
"short": "Offset",
"definition": "Character offset of the extracted term in the input note",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.offset",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.lexical-variant",
"path": "NoteNLP.lexical_variant",
"short": "Lexical Variant",
"definition": "Raw text extracted from the NLP tool.",
"min": 1,
"max": "1",
"base": {
"path": "NoteNLP.lexical_variant",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.note-nlp-concept-id",
"path": "NoteNLP.note_nlp_concept_id",
"short": "Note NLP",
"definition": "Note NLP",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.note_nlp_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "NoteNLP.note-nlp-source-concept-id",
"path": "NoteNLP.note_nlp_source_concept_id",
"short": "Note NLP Source",
"definition": "Note NLP Source",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.note_nlp_source_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "NoteNLP.nlp-system",
"path": "NoteNLP.nlp_system",
"short": "NLP System",
"definition": "NLP System",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.nlp_system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.nlp-date",
"path": "NoteNLP.nlp_date",
"short": "NLP Date",
"definition": "The date of the note processing.",
"min": 1,
"max": "1",
"base": {
"path": "NoteNLP.nlp_date",
"min": 1,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "NoteNLP.nlp-datetime",
"path": "NoteNLP.nlp_datetime",
"short": "NLP Datetime",
"definition": "The date and time of the note processing.",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.nlp_datetime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "NoteNLP.term-exists",
"path": "NoteNLP.term_exists",
"short": "Term Exists",
"definition": "Term Exists",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.term_exists",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.term-temporal",
"path": "NoteNLP.term_temporal",
"short": "Term Temporal",
"definition": "Term Temporal",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.term_temporal",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.term-modifiers",
"path": "NoteNLP.term_modifiers",
"short": "Term Modifiers",
"definition": "Term Modifiers",
"min": 0,
"max": "1",
"base": {
"path": "NoteNLP.term_modifiers",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "NoteNLP",
"path": "NoteNLP",
"short": "Note NLP OMOP Table",
"definition": "The NOTE_NLP table encodes all output of NLP on clinical notes. Each row represents a single extracted term from a note."
},
{
"id": "NoteNLP.note-nlp-id",
"path": "NoteNLP.note_nlp_id",
"short": "Note NLP Identifier",
"definition": "Note NLP Identifier",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "NoteNLP.note-id",
"path": "NoteNLP.note_id",
"short": "Note",
"definition": "This is the NOTE_ID for the NOTE record the NLP record is associated to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/uv/omop/StructureDefinition/Note"
]
}
]
},
{
"id": "NoteNLP.section-concept-id",
"path": "NoteNLP.section_concept_id",
"short": "Section",
"definition": "Section",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "NoteNLP.snippet",
"path": "NoteNLP.snippet",
"short": "Snippet",
"definition": "A small window of text surrounding the term",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.offset",
"path": "NoteNLP.offset",
"short": "Offset",
"definition": "Character offset of the extracted term in the input note",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.lexical-variant",
"path": "NoteNLP.lexical_variant",
"short": "Lexical Variant",
"definition": "Raw text extracted from the NLP tool.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.note-nlp-concept-id",
"path": "NoteNLP.note_nlp_concept_id",
"short": "Note NLP",
"definition": "Note NLP",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "NoteNLP.note-nlp-source-concept-id",
"path": "NoteNLP.note_nlp_source_concept_id",
"short": "Note NLP Source",
"definition": "Note NLP Source",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "NoteNLP.nlp-system",
"path": "NoteNLP.nlp_system",
"short": "NLP System",
"definition": "NLP System",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.nlp-date",
"path": "NoteNLP.nlp_date",
"short": "NLP Date",
"definition": "The date of the note processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "NoteNLP.nlp-datetime",
"path": "NoteNLP.nlp_datetime",
"short": "NLP Datetime",
"definition": "The date and time of the note processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "NoteNLP.term-exists",
"path": "NoteNLP.term_exists",
"short": "Term Exists",
"definition": "Term Exists",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.term-temporal",
"path": "NoteNLP.term_temporal",
"short": "Term Temporal",
"definition": "Term Temporal",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "NoteNLP.term-modifiers",
"path": "NoteNLP.term_modifiers",
"short": "Term Modifiers",
"definition": "Term Modifiers",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}